home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / sgihelpmsg.z / sgihelpmsg
Encoding:
Text File  |  2002-10-03  |  7.1 KB  |  133 lines
  1.  
  2.  
  3.  
  4. SSSSGGGGIIIIHHHHeeeellllppppMMMMssssgggg((((3333))))                                                    SSSSGGGGIIIIHHHHeeeellllppppMMMMssssgggg((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSSSGGGGIIIIHHHHeeeellllppppIIIInnnniiiitttt, SSSSGGGGIIIIHHHHeeeellllppppMMMMssssgggg, SSSSGGGGIIIIHHHHeeeellllppppIIIInnnnddddeeeexxxxMMMMssssgggg - help functions
  10.  
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<hhhheeeellllppppaaaappppiiii////HHHHeeeellllppppBBBBrrrrooookkkkeeeerrrr....hhhh>>>>
  14.  
  15.      iiiinnnntttt SSSSGGGGIIIIHHHHeeeellllppppMMMMssssgggg ((((cccchhhhaaaarrrr ****iiiinnnn____kkkkeeeeyyyy,,,, cccchhhhaaaarrrr ****iiiinnnn____bbbbooooooookkkk,,,, cccchhhhaaaarrrr**** uuuusssseeeerrrr____ddddaaaattttaaaa))));;;;
  16.  
  17.      iiiinnnntttt SSSSGGGGIIIIHHHHeeeellllppppIIIInnnniiiitttt((((DDDDiiiissssppppllllaaaayyyy ****iiiinnnn____ddddsssspppp,,,, cccchhhhaaaarrrr ****iiiinnnn____cccclllliiiieeeennnntttt,,,, cccchhhhaaaarrrr ****iiiinnnn____sssseeeepppp))));;;;
  18.  
  19.      iiiinnnntttt SSSSGGGGIIIIHHHHeeeellllppppIIIInnnnddddeeeexxxxMMMMssssgggg ((((cccchhhhaaaarrrr ****iiiinnnn____kkkkeeeeyyyy,,,, cccchhhhaaaarrrr ****iiiinnnn____bbbbooooooookkkk))));;;;
  20.  
  21.  
  22. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  23.      _S_G_I_H_e_l_p_M_s_g provides for communication with ssssggggiiiihhhheeeellllpppp(1), the SGI Help
  24.      System.
  25.  
  26.      Programs wishing to utilize this functionality must call the function
  27.      _S_G_I_H_e_l_p_I_n_i_t once to initialize the API. The pointer to the open Display
  28.      (see XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy(3X11)) and the application's client (class) name
  29.      (usually the same name as the application's resource file; see
  30.      XXXXttttAAAAppppppppIIIInnnniiiittttiiiiaaaalllliiiizzzzeeee(3Xt)) must be provided. The third parameter, the
  31.      separator character used in the application's helpmap file, should be set
  32.      to NULL (to utilize the API default). Calling _S_G_I_H_e_l_p_I_n_i_t more than once
  33.      during program execution is harmless, but is unnecessary.
  34.  
  35.      The _S_G_I_H_e_l_p_M_s_g call provides a method for communication with the help
  36.      server process, ssssggggiiiihhhheeeellllpppp(1). This process will start automatically when a
  37.      request for help is generated, if it is not already running on the
  38.      system. The calling application (making the help request) can send in the
  39.      _k_e_y and _b_o_o_k, which tells the help server (ssssggggiiiihhhheeeellllpppp(1)) which help card to
  40.      display.  Note that help cards come from books found within the online
  41.      documentation library.
  42.  
  43.      The _S_G_I_H_e_l_p_I_n_d_e_x_M_s_g call tells the help server process, ssssggggiiiihhhheeeellllpppp(1), to
  44.      display a list of available topics for this application. Note that a
  45.      content provider must prepare a helpmap file for this to work.
  46.  
  47.      Refer to the IIIIRRRRIIIIXXXX IIIInnnntttteeeerrrraaaaccccttttiiiivvvveeee DDDDeeeesssskkkkttttoooopppp((((TTTTMMMM)))) IIIInnnntttteeeeggggrrrraaaattttiiiioooonnnn GGGGuuuuiiiiddddeeee for more
  48.      information on this topic and on providing/creating help content for your
  49.      application to work in conjunction with ssssggggiiiihhhheeeellllpppp(1).
  50.  
  51. DDDDEEEEFFFFIIIINNNNIIIITTTTIIIIOOOONNNNSSSS
  52.      A bbbbooooooookkkksssshhhheeeellllffff is defined as a directory containing a set of books.  By
  53.      default, bookshelves are located in
  54.      /_u_s_r/_s_h_a_r_e/_I_n_s_i_g_h_t/_l_i_b_r_a_r_y/_S_G_I__b_o_o_k_s_h_e_l_v_e_s To examine a sample bookshelf,
  55.      look under this default path.  Most of the directories contained under
  56.      this area are defined as bbbbooooooookkkksssshhhheeeellllvvvveeeessss.
  57.  
  58.      By convention, below each of those bbbbooooooookkkksssshhhheeeellllffff directories exists a
  59.      subdirectory named _b_o_o_k_s. The _b_o_o_k_s subdirectory contains all available
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSGGGGIIIIHHHHeeeellllppppMMMMssssgggg((((3333))))                                                    SSSSGGGGIIIIHHHHeeeellllppppMMMMssssgggg((((3333))))
  71.  
  72.  
  73.  
  74.      online books for this bbbbooooooookkkksssshhhheeeellllffff.
  75.  
  76.      For example, examining the path:
  77.  
  78.        /_u_s_r/_s_h_a_r_e/_I_n_s_i_g_h_t/_l_i_b_r_a_r_y/_S_G_I__b_o_o_k_s_h_e_l_v_e_s/_S_G_I__E_n_d_U_s_e_r/_b_o_o_k_s/_D_e_s_k_t_o_p__U_G
  79.  
  80.      _S_G_I__E_n_d_U_s_e_r is the bbbbooooooookkkksssshhhheeeellllffff and _D_e_s_k_t_o_p__U_G is the bbbbooooooookkkk.
  81.  
  82. NNNNOOOOTTTTEEEESSSS
  83.      The application must link with the library _l_i_b_h_e_l_p_m_s_g._s_o and must include
  84.      the file <_h_e_l_p_a_p_i/_H_e_l_p_B_r_o_k_e_r._h>.
  85.  
  86. SSSSEEEECCCCUUUURRRRIIIITTTTYYYY NNNNOOOOTTTTEEEE
  87.      Programs running suid root should examine the documentation for
  88.      ssssggggiiiihhhheeeellllpppp(1) carefully before utilizing the help system; there are security
  89.      concerns for that class of applications. Using ssssggggiiiihhhheeeellllpppp(1) for a program
  90.      running suid root is not recommended.
  91.  
  92. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  93.      IIIIRRRRIIIIXXXX IIIInnnntttteeeerrrraaaaccccttttiiiivvvveeee DDDDeeeesssskkkkttttoooopppp((((TTTTMMMM)))) IIIInnnntttteeeeggggrrrraaaattttiiiioooonnnn GGGGuuuuiiiiddddeeee, ssssggggiiiihhhheeeellllpppp(1)
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.